Properties

Name Returns Notes Example
groups List
matchMethods List
pendingApplications List Return the list of membership applications which the current user is permitted to process

Methods

Name Returns Notes Example
membershipList ( p ) MembershipList Return a MembershipList with all memberships for the given profile. This provides methods to allow filtering by group, organisation, etc
findAddresses ( entity ) List Find all addressess associated with the given entity (user or organisation)
findAddress ( profile, entityAddressId ) EntityAddress Find an address specified by the ID of the entity address (not the Address itself) for a given entity Returns null if the EntityAddress does not exist, or is not associated with the given entity
updateAddress ( profile, rc ) EntityAddress Update or create profile address
updateAddress ( profile, entityAddressId, rc, type ) EntityAddress
findAllMembershipApplications ( profile ) List
findPendingMembershipApplications ( profile ) List
createUser ( email, nickName ) Profile
extraFields ( p ) Map
extraFields ( bean ) Map
extraFieldValue ( bean, fieldName ) String
updateUser ( p ) void Just saves any updates to the profile object, and triggers a reindex of it
storeExtrFields ( gm, parameters ) void Saves custom fields for a single membership. Assumes fields are in the params map with the same field as defined on the membership group
storeExtrFields ( p, parameters ) void Assumes fields are named as MEMBERSHIPID.FIELDNAME, eg name="43653.favColour"
group ( groupName ) Group
findOrg ( orgId ) Organisation
findOrg ( id ) Organisation
findOrCreateMembership ( profile, group, org ) GroupMembership
newMembershipApplication ( profile, group, org, form ) GroupMembershipApplication
findByName ( name ) Profile
findById ( id ) Profile
findMatching ( request ) List Find any enabled profiles with either phone or email
newProfileMatchRequest ( ) ProfileMatchRequest Create a new match request object. You can then set search values on that object, and use it to call the findMatching method
findChildMembershipByField ( groupName, fieldName, ovalue, contains ) MembershipBean
mergeProfiles ( mergeDestination, mergeSources ) void
mergeProfiles ( mergeDest, mergeSources ) int
groups ( ) List Find all groups (not soft deleted) for the current admin domain
orgTypes ( ) List Return all org types for the current admin domain
toProfileBean ( p ) ExtProfileBean
toOrgData ( org ) OrgData
toOrg ( od ) Organisation
toOrgList ( orgDatas ) List
findHighest ( orgs ) Organisation Find the organisation highest in the org hierarchy, ie the one with the fewest parent orgs
members ( group, org ) List Find users (profiles) within a given gruop for a given organisation (ie team)
members ( group, props ) List
memberships ( group, org ) List
memberships ( profile, org ) List
memberships ( profile, teamOrgType ) List
setMembershipField ( membershipBean, fieldName, fieldValue ) void
findDuplicates ( matchMethod, mode ) List
findByOrg ( team ) List
processPending ( gma, b ) void
setPassword ( user, newPassword ) void